Renegociação
Esta API permite a renegociação e regularização de contratos com base em diferentes elegibilidades, oferecendo diversas campanhas para regularização e facilitando simulações antes da efetivação do acordo. Além disso, é possível consultar os boletos gerados após efetivação do acordo e/ou cancelar a renegociação antes do pagamento da parcela de adesão (primeira parcela).
Elegibilidade
Elegibilidade refere-se a um ou mais métodos de renegociação e regularização de contratos em situação irregular. As elegibilidades são pré-estabelecidas pela equipe interna de gerenciamento de contratos, podendo haver diferentes tipos, cada um com critérios específicos. Tais diferenças podem ser visíveis nos campos type e installment_agreement_type, onde possuem os respectivos valores:
type:
- TOTAL: pré-pagamento de um contrato único.
- WRAP: unificação de diferentes contratos, também chamado de empacotamento.
installment_agreement_type:
- Disabled: somente pagamento à vista do valor devido.
- OnlyVNP: somente o pagamento de valores vencidos.
- NotVNP: somente o pré-pagamento de valores futuros.
- All: permite todas as opções acima.
Uma vez que não é gerado um novo contrato com novas parcelas, prazos e valores, pagamentos à vista do valor devido são considerados apenas como regularização, caso contrário, se torna uma renegociação. Uma renegociação ainda oferece possibilidade de empacotamento, que nada mais é do que a unificação de diferentes contratos com o objetivo de simplificar ainda mais o acordo com o devedor.
É possível visualizar os contratos informando o fundo através do campo fund_tax_id e seu respectivo cliente representado por customer_tax_id.
// exemplo de resposta:
[
{
"contracts": [
{
"balance": {
"curve_value": 3111.1,
"fixed_interest_value": 653.51,
"float_interest_value": 0,
"interest_arrears_value": 3.55,
"interest_value": 0,
"iof_fee_value": 0.32,
"late_payment_value": 0,
"penalty_fee_value": 22.47,
"principal_value": 2431.25,
"spread_rate": 49.190931
},
"contract": "AUX-55335009",
"cros_contract": "0002391480/RMD_TEST_022",
"due_days": 273,
"installments": [
{
"curve_value\"": 164.23,
"fixed_interest_value\"": 7.37,
"float_interest_value\"": 0,
"has_processing_payments": false,
"installment_number\"": 1,
"interest_arrears_value\"": 0.96,
"iof_value\"": 0.05,
"is_vnp": true,
"late_payment_value\"": 0,
"maturity_date": "2022-11-30T00:00:00",
"maturity_value\"": 160,
"penalty_fee_value\"": 3.22,
"principal_value\"": 152.63,
"status": "Opened"
}
],
"name": "FIDC MT Auxilio Brasil"
}
],
"description": "Reneg. Simples",
"id": "COL_RISK_POLICY_TEST",
"installment_agreement_type": "Disabled",
"type": "TOTAL"
}
]
Campanha
Uma campanha representa uma estratégia específica para a renegociação de contratos dentro de uma determinada elegibilidade. Cada tipo de elegibilidade pode ter várias campanhas associadas a ela, oferecendo opções diversas para a regularização do contrato.
Por exemplo, uma campanha dentro de determinada elegibilidade pode oferecer descontos exclusivos, enquanto uma outra campanha para mesma elegibilidade pode fornecer planos de pagamento diferenciados.
É possível visualizar as campanhas de um ou mais contratos, contract[] informando o fundo através do campo fund_tax_id e seu respectivo cliente representado por customer_tax_id.
// exemplo de resposta:
{
[
{
"affinity_score": 5,
"code": "123456",
"first_payment_options": [
{
"description": "Boleto",
"id": 1,
"name": "BANKSLIP"
}
],
"grace_period_flow": {
"max_value": 0,
"name": "Carência de Parcelas",
"type": "Cashflow"
},
"guarantor_type": "ORIGINAL",
"installment_agreement_type": "All",
"installment_ranges": [
{
"discount_fields": [
{
"percent": 0,
"text": "Principal",
"value": "Main"
}
],
"max_installments": 1,
"min_installments": 1
}
],
"installments_payment_options": [
{
"description": "Boleto",
"id": 1,
"name": "BANKSLIP"
}
],
"interest_payment_type": "Juros Originais",
"interest_rate": 0,
"minimum_installment_amount": 0.1,
"minimun_entry_amount": 155.56,
"name": "123456",
"payment_dates": [
"2023-08-30"
],
"payment_periodicity": null
}
]
}
Simulação
A etapa de simulação de uma renegociação é a etapa em que é de fato validado se o cliente, identificado por customer_tax_id, está apto em utilizar determinada campanha disponível para o contrato, onde é checado todos valores e taxas inclusas na campanha, identificada por campaign_code.
// exemplo de resposta:
{
"contracts": [
"CONTRACT-001"
],
"cros_contracts": [
"0000000000/CONTRACT_TEST_001"
],
"debt_current_values": 3100,
"debts": [
{
"channel": "fidc",
"company": {
"business_name": "BANCO BTG PACTUAL S.A.",
"id": "30306294000145"
},
"contract": "CONTRACT-001",
"cros_contract": "0000000000/CONTRACT_TEST_001",
"curve_value": 3100,
"due_date": "2022-10-07T00:00:00",
"due_days": 273,
"installments": [
{
"curve_value": 164.23,
"installment_number": 1,
"is_vnp": true,
"maturity_date": "2022-11-30T00:00:00",
"maturity_value": 160,
"principal_value": 152.63
}
],
"installments_count": 24,
"interest_value": 653.51,
"is_late": true,
"principal_value": 2431.25,
"product": "PRODUCT",
"product_description": "FIDC Product Description",
"product_type": 0,
"spread_rate": 49.190931,
"total_balance": 0,
"trade_id": "82743754",
"updated_at": "2023-07-07T00:00:00"
}
],
"eligibility": "TESTE_FIDC",
"first_payment_date": "2023-08-30",
"first_payment_options": [
{
"description": "Boleto",
"id": 1,
"name": "BANKSLIP"
}
],
"id": "ef1e7735-de4f-437b-af6c-3fcec6024e4c",
"input_value": 0,
"installment_options": [
{
"annual_interest_rate": 12059.314432,
"cet_rate": 100,
"current_value_discount_percentage": 0.45,
"current_value_discount_value": 14.15,
"discount_percentage": 0.83,
"installments": [
{
"amortization\"": 3122.96727565,
"balance\"": 0,
"discount\"": 26.02,
"discount_percentage\"": 0.8331819613634702,
"due_date\"": "2023-08-30T00:00:00",
"end_accrual\"": "2023-08-30T00:00:00",
"incorporated_days\"": 0,
"incorporation_flag\"": false,
"index\"": 1,
"installment_value\"": 3122.96727565,
"installment_value_with_discount\"": 3096.94727565,
"interest_value\"": 0,
"iof_value\"": 11.86727565,
"main_ticket\"": 3122.96727565,
"start_accrual\"": "2023-08-30T00:00:00"
}
],
"installments_count\"": 1,
"monthly_interest_rate\"": null,
"original_interest_rate\"": 49.190931,
"simulation_id\"": "c9076271-a5d3-482f-83b1-befec70f235f",
"total_discount_value\"": 26.02,
"total_fee_value\"": 0,
"total_interest_value\"": 0,
"total_iof_value\"": 11.86727565,
"total_value\"": 3122.96727565,
"total_value_with_discount\"": 3096.94727565
}
],
"installments_payment_options": [
{
"description": "Boleto",
"id": 1,
"name": "BANKSLIP"
}
],
"max_installments_count": 1,
"requested_installments": [
""
],
"requested_installments_count": 1,
"status": "OPEN"
}
Confirmação
Após a simulação será obtido o valor do simulation_identification, que será necessário para confirmar o acordo, onde a renegociação se tornará de fato efetiva. Nessa etapa também é possível realizar o pré-pagamento através da informação de campos como método de pagamento e quantidade de parcelas.
// exemplo de resposta:
{
"agreement_id": "2ec83742-1ed6-9374-ac14-48f57c5f5ebb",
"contract": "0002391480/RMD_TEST_022",
"due_date": "2023-08-30T00:00:00",
"offer_id": "6fd12837-42ee-42a0-ab53-e49b42f5236d",
"serial": 2800
}
Cancelamento
Após o acordo ser confirmado, existe a possibilidade de cancelar a renegociação informando o identificador do acordo agreement_id e do cliente customer_tax_id, porém, ==só será possível o cancelamento em casos que não foram realizados o pagamento da parcela de adesão (primeira parcela).
Boletos
Após confirmação do acordo de renegociação, já é possível consultar o boleto gerado para pagamento, em cenários que foram gerados mais de um boleto, basta informar o número da parcela no campo installment_number.
// exemplo de resposta:
{
"agreement_id": "2ec83742-1ed6-9374-ac14-48f57c5f5ebb",
"bar_code": "83928394300003234890001010000000003849504938",
"base64_representation": "base64",
"due_date": "2023-09-14T00:00:00",
"installment": 1,
"offer_id": "6fd12837-42ee-42a0-ab53-e49b42f5236d"
}
Recursos Disponíveis
Os recursos da API de Renegociação estão disponíveis no API Reference.